类: UIDashboard

dashboard.UIDashboard

Hierarchy

• UIWidget

  ↳ UIDashboard

Table of contents

构造方法

• constructor

属性

• pages

方法

• connect
• destroy
• disconnect
• getCurrentPage
• getName
• getPageByID
• getPageByName
• getScenarioByID
• getScenarioByName
• isConnected
• off
• on
• once
• refresh
• resize
• resume
• showNextPage
• showPrevPage
• suspend

构造方法

constructor

• new UIDashboard()

Inherited from

UIWidget.constructor

属性

pages

• pages: UIPage[]

当前文档的所有页面

方法

connect

▸ connect(container): void

用于连接一个DOM元素，该实例将挂载到该DOM元素上

参数

名称	类型
container	Element

返回值

void

Inherited from

UIWidget.connect

---

destroy

▸ destroy(): void

释放当前实例的资源

返回值

void

Inherited from

UIWidget.destroy

---

disconnect

▸ disconnect(): void

用于断开与当前DOM元素的连接

返回值

void

Inherited from

UIWidget.disconnect

---

getCurrentPage

▸ getCurrentPage(): UIPage

获取文档的当前页面

返回值

UIPage

---

getName

▸ getName(): string

返回当前实例的名称

返回值

string

Inherited from

UIWidget.getName

---

getPageByID

▸ getPageByID(id): UIPage

按页面ID获取页面

参数

名称	类型
id	string

返回值

UIPage

---

getPageByName

▸ getPageByName(pageName): UIPage

按页面名称获取页面

参数

名称	类型
pageName	string

返回值

UIPage

---

getScenarioByID

▸ getScenarioByID(scenarioID): UIScenario

按组件ID返回可视化组件

参数

名称	类型
scenarioID	string

返回值

UIScenario

---

getScenarioByName

▸ getScenarioByName(scenarioName): UIScenario

按组件名称返回可视化组件

参数

名称	类型
scenarioName	string

返回值

UIScenario

---

isConnected

▸ isConnected(): boolean

获取当前实例是否已挂载

返回值

boolean

Inherited from

UIWidget.isConnected

---

off

▸ off(type, cb): void

取消仪表板事件监听

参数

名称	类型	描述
type	EventType	指定注册的事件类型
cb	(...args: any[]) => void	指定事件的回调函数

返回值

void

Inherited from

UIWidget.off

---

on

▸ on(type, cb): void

用于监听仪表板事件

参数

名称	类型	描述
type	EventType	指定注册的事件类型
cb	(...args: any[]) => void	指定事件的回调函数

返回值

void

Inherited from

UIWidget.on

---

once

▸ once(type, cb): void

监听仪表板事件，该事件将仅被调用一次

参数

名称	类型	描述
type	EventType	指定注册的事件类型
cb	(...args: any[]) => void	指定事件的回调函数

返回值

void

Inherited from

UIWidget.once

---

refresh

▸ refresh(): void

刷新当前实例

返回值

void

Inherited from

UIWidget.refresh

---

resize

▸ resize(): void

调整当前实例内容的大小

返回值

void

Inherited from

UIWidget.resize

---

resume

▸ resume(): void

恢复当前实例

返回值

void

Inherited from

UIWidget.resume

---

showNextPage

▸ showNextPage(): UIPage

获取文档的下一页

返回值

UIPage

---

showPrevPage

▸ showPrevPage(): UIPage

获取文档的上一页

返回值

UIPage

---

suspend

▸ suspend(): void

挂起当前实例

返回值

void

Inherited from

UIWidget.suspend